home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmTransferDone.z / XmTransferDone
Encoding:
Text File  |  2002-10-03  |  8.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee - A toolkit function that completes a data
  10.           transfer
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.  
  15.           vvvvooooiiiidddd XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee(
  16.           XXXXttttPPPPooooiiiinnnntttteeeerrrr ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd,
  17.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss ssssttttaaaattttuuuussss);
  18.  
  19.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  20.           This page documents Motif 2.1.
  21.  
  22.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee completes an already-initiated data transfer
  24.           operation.  An application can call this routine from an
  25.           XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedure or any function called as a
  26.           result, including the selection procedures called as a
  27.           result of calls to XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee.
  28.  
  29.           The caller of XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee supplies an identifier for the
  30.           transfer operation and an indication of the completion
  31.           status.  XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee causes any remaining transfers for
  32.           the operation to be discarded.
  33.  
  34.           ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd
  35.                     Specifies a unique indentifier for the data
  36.                     transfer operation.  The value must be the same as
  37.                     the value of the ttttrrrraaaannnnssssffffeeeerrrr____iiiidddd member of the
  38.                     XXXXmmmmDDDDeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt passed to the
  39.                     XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedure.
  40.  
  41.           _s_t_a_t_u_s    Specifies the completion status of the data
  42.                     transfer.  Following are the possible values:
  43.  
  44.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____SSSSUUUUCCCCCCCCEEEEEEEEDDDD
  45.                               The transfer was completed successfully.
  46.                               This status has the following additional
  47.                               effects:
  48.  
  49.                                  +o  For a move operation, the
  50.                                     selection owner receives a request
  51.                                     to convert the selection to the
  52.                                     _D_E_L_E_T_E target.
  53.  
  54.                                  +o  If a _T_R_A_N_S_A_C_T operation is in
  55.                                     progress, the owner receives a
  56.                                     request to commit the transaction.
  57.  
  58.                                  +o  If a _P_E_R_S_I_S_T or ____MMMMOOOOTTTTIIIIFFFF____SSSSNNNNAAAAPPPPSSSSHHHHOOOOTTTT
  59.                                     operation is in progress, the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                                     owner receives a notification that
  75.                                     the operation is finished.
  76.  
  77.                                  +o  The widget class destination
  78.                                     procedure is not called.
  79.  
  80.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____FFFFAAAAIIIILLLL
  81.                               The transfer was completed
  82.                               unsuccessfully.  This status has the
  83.                               following additional effects:
  84.  
  85.                                  +o  For a move operation, the
  86.                                     selection owner does not receive a
  87.                                     request to convert the selection
  88.                                     to the _D_E_L_E_T_E target.
  89.  
  90.                                  +o  For a drag and drop operation, the
  91.                                     DropTransfer's XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss
  92.                                     is set to XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____FFFFAAAAIIIILLLLUUUURRRREEEE.
  93.  
  94.                                  +o  If a _T_R_A_N_S_A_C_T operation is in
  95.                                     progress, the owner receives a
  96.                                     request to abort the transaction.
  97.  
  98.                                  +o  If a _P_E_R_S_I_S_T or ____MMMMOOOOTTTTIIIIFFFF____SSSSNNNNAAAAPPPPSSSSHHHHOOOOTTTT
  99.                                     operation is in progress, the
  100.                                     owner receives a notification that
  101.                                     the operation is finished.
  102.  
  103.                                  +o  The widget class destination
  104.                                     procedure is not called.
  105.  
  106.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____CCCCOOOONNNNTTTTIIIINNNNUUUUEEEE
  107.                               This status has the same effect as
  108.                               XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____SSSSUUUUCCCCCCCCEEEEEEEEDDDD, except that if
  109.                               a _P_E_R_S_I_S_T or ____MMMMOOOOTTTTIIIIFFFF____SSSSNNNNAAAAPPPPSSSSHHHHOOOOTTTT operation
  110.                               is in progress, the owner does not
  111.                               receive a notification that the
  112.                               operation is finished.
  113.  
  114.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____DDDDEEEEFFFFAAAAUUUULLLLTTTT
  115.                               The widget class destination procedure
  116.                               is called.  Further effects depend on
  117.                               the actions of that procedure.
  118.  
  119.      RRRREEEELLLLAAAATTTTEEEEDDDD
  120.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrSSSSeeeennnnddddRRRReeeeqqqquuuueeeesssstttt(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrttttRRRReeeeqqqquuuueeeesssstttt(3),
  121.           XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrttttRRRReeeeqqqquuuueeeesssstttt(3), and XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee(3).
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.